<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
  "http://www.w3.org/TR/html4/loose.dtd">
<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <title>Introduction to build.py &mdash; build.py Documentation</title>
    <link rel="stylesheet" href="../style/default.css" type="text/css">
    <link rel="stylesheet" href="../style/pygments.css" type="text/css">
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:   '../',
        VERSION:    '0.3'
      };
    </script>
    <script type="text/javascript" src="../style/jquery.js"></script>
    <script type="text/javascript" src="../style/interface.js"></script>
    <script type="text/javascript" src="../style/doctools.js"></script>
    <link rel="contents" title="Global table of contents" href="../contents.html">
    <link rel="index" title="Global index" href="../genindex.html">
    <link rel="search" title="Search" href="../search.html">
    <link rel="top" title="build.py Documentation" href="../index.html">
    <link rel="up" title="build.py Tutorial contents" href="index.html">
    <link rel="next" title="Quickstart guide" href="quickstart.html">
    <link rel="prev" title="build.py Tutorial contents" href="index.html">
    
  </head>
  <body>

    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px"><a href="../genindex.html" title="General Index" accesskey="I">index</a></li>
        <li class="right"><a href="../modindex.html" title="Global Module Index" accesskey="M">modules</a> |</li>
          <li class="right"><a href="quickstart.html" title="Quickstart guide" accesskey="N">next</a> |</li>
          <li class="right"><a href="index.html" title="build.py Tutorial contents" accesskey="P">previous</a> |</li>
        <li><a href="../index.html">build.py v0.3 Documentation</a> &raquo;</li>
          <li><a href="index.html" accesskey="U">build.py Tutorial contents</a> &raquo;</li>
      </ul>
    </div>

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  
  <div class="section">
<h1 id="introduction-to-build-py">Introduction to build.py<a class="headerlink" href="#introduction-to-build-py" title="Permalink to this headline">¶</a></h1>
<p>build.py is a Python application, designed to aid in software building and all things related. It consists of one executuable Python file which can be placed in user&#8217;s system or distributed with software package. When launched, build.py searches for file called <em>Buildfile</em> - it&#8217;s analogous to Make&#8217;s Makefiles or Jamfiles. Buildfile contains all package-specific informations, like location of sources, default compilator etc.</p>
<div class="section">
<h2 id="running-build-py">Running build.py<a class="headerlink" href="#running-build-py" title="Permalink to this headline">¶</a></h2>
<p>You can run build.py in two manners::</p>
<pre>python build.py [TARGET(S)]
./build.py [TARGET(S)]</pre>
<p>The latter one is preferred, assuming build.py has permissions to execute itself.</p>
</div>
<div class="section">
<h2 id="packages-and-targets">Packages and targets<a class="headerlink" href="#packages-and-targets" title="Permalink to this headline">¶</a></h2>
<p>When using build.py, one must two basic terms involved in making Buildfiles: <em>packages</em> and <em>targets</em></p>
<dl class="docutils">
<dt>Package</dt>
<dd>One, logic part in Buildfile - it represents one software application. Each Buildfile can contain many packages.</dd>
<dt>Target</dt>
<dd>Target is an <em>action</em> connected with particular package. It could be, for example, &#8216;install&#8217; or &#8216;build&#8217;</dd>
</dl>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sidebar">
        <div class="sidebarwrapper">
          
            <h3>Table Of Contents</h3>
            <ul>
<li><a class="reference" href="">Introduction to build.py</a><ul>
<li><a class="reference" href="#running-build-py">Running build.py</a></li>
<li><a class="reference" href="#packages-and-targets">Packages and targets</a></li>
</ul>
</li>
</ul>

          
            <h4>Previous topic</h4>
            <p class="topless"><a href="index.html" title="previous chapter">build.py Tutorial contents</a></p>
            <h4>Next topic</h4>
            <p class="topless"><a href="quickstart.html" title="next chapter">Quickstart guide</a></p>
          
            <h3>This Page</h3>
            <ul class="this-page-menu">
            
              <li><a href="../_sources/tutorial/introduction.txt">Show Source</a></li>
            
            </ul>
          
          
          
        </div>
      </div>
      <div class="clearer"></div>
    </div>

    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px"><a href="../genindex.html" title="General Index" accesskey="I">index</a></li>
        <li class="right"><a href="../modindex.html" title="Global Module Index" accesskey="M">modules</a> |</li>
          <li class="right"><a href="quickstart.html" title="Quickstart guide" accesskey="N">next</a> |</li>
          <li class="right"><a href="index.html" title="build.py Tutorial contents" accesskey="P">previous</a> |</li>
        <li><a href="../index.html">build.py v0.3 Documentation</a> &raquo;</li>
          <li><a href="index.html" accesskey="U">build.py Tutorial contents</a> &raquo;</li>
      </ul>
    </div>

    <div class="footer">
      &copy; Copyright 2008, Michal Hordecki.
      Last updated on Feb 10, 2008.
    </div>
  </body>
</html>